Skip to main content
PUT
/
api
/
v1
/
projects
/
{id}
Updates an existing :ref:`ref_flyteidl.admin.Project` flyteidl.admin.Project
curl --request PUT \
  --url https://mycluster.domino.tech/api/v1/projects/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "domains": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "description": "<string>",
  "labels": {
    "values": {}
  },
  "state": "ACTIVE",
  "org": "<string>"
}
'
{}

Path Parameters

​
id
string
required

Globally unique project name.

Body

application/json

Top-level namespace used to classify different entities like workflows and executions.

​
name
string

Display name.

​
domains
object[]
​
description
string
​
labels
object

Label values to be applied to an execution resource. In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined to specify how to merge labels defined at registration and execution time.

​
state
enum<string>
default:ACTIVE

The state of the project is used to control its visibility in the UI and validity.

  • ACTIVE: By default, all projects are considered active.
  • ARCHIVED: Archived projects are no longer visible in the UI and no longer valid.
  • SYSTEM_GENERATED: System generated projects that aren't explicitly created or managed by a user.
  • SYSTEM_ARCHIVED: System archived projects that aren't explicitly archived by a user.
Available options:
ACTIVE,
ARCHIVED,
SYSTEM_GENERATED,
SYSTEM_ARCHIVED
​
org
string

Optional, org key applied to the resource.

Response

A successful response.

Purposefully empty, may be updated in the future.